home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / cleantxt.arc / CLEANTXT.DOC < prev   
Encoding:
Text File  |  1987-04-25  |  5.7 KB  |  134 lines
  1.  
  2.                         PROGRAM NAME:   CLEANTXT
  3.                              VERSION:   1.0
  4.                                 DATE:   4-24-87
  5.                                  FOR:   IBM PC'S OR COMPATIBLES
  6.                   PROGRAM WRITTEN IN:   ASSEMBLY LANGUAGE
  7.                               AUTHOR:   JOHN GASAL
  8.                              ADDRESS:   ANOKA,MN 55303 
  9. A: GENERAL DESCRIPTION
  10.  
  11. CLEANTXT IS A GENERAL PURPOSE DOS FILTER WHOSE NORMAL PURPOSE IS TO CLEAN UP 
  12. TEXT FILES BY:  
  13.                 1. ELIMINATING TRAILING BLANKS IN TEXT.
  14.  
  15.                 2. REMOVE END OF FILE CHARACTERS (1A HEX) EMBEDDED IN THE 
  16.                 MIDDLE OF TEXT WHICH MAY PREVENT Y0U FROM PROCESSING AN 
  17.                 ENTIRE TEXT FILE.  SOMETIMES YOU GET EMBEDDED END OF FILE 
  18.                 CHARACTER WHEN YOU APPEND ONE FILE TO ANOTHER.  THE END 
  19.                 OF FILE MARKER AT THE END OF THE FILE IS ALSO REMOVED AS 
  20.                 DOS DOES NOT NEED THIS. 
  21.  
  22.                 3. FIXING 'FUNNY' CARRIAGE RETURNS(CR) AND LINE 
  23.                 FEEDS(LF) SO THAT EVERY LINE FEED IS ALWAYS PRECEDED BY 
  24.                 A CARRIAGE RETURN. 
  25.  
  26.                 4. EXPAND TAB MARKS (09 HEX) SO THAT THE PROPER NUMBER OF 
  27.                 SPACES REPLACE THE TAB MARK.
  28.  
  29.  
  30. OPTIONALLY THE PROGRAM CAN:
  31.  
  32.                 1. DELETE FORM FEED CHARACTERS (0C HEX).
  33.  
  34.                 2. CHANGE CHARACTERS TO EITHER LOWER OR UPPER CASE.
  35.  
  36.                 3. STRIP HIGH BITS AS ONE MIGHT ENCOUNTER IN A FILE 
  37.                 CREATED BY WORDSTAR.  THIS APPLIES TO ASCII CHARACTERS 
  38.                 128 THROUGH 255.
  39.  
  40.                 4. DELETE THE HIGH ORDER ASCII CHARACTERS (IE, ASCII 
  41.                 CHARACTERS 128 THROUGH 255).
  42.  
  43.                 5. LIMIT THE NUMBER OF BLANK LINES BETWEEN ANY BLOCK OF 
  44.                 TEXT TO A PREDETERMINED NUMBER BETWEEN 0 (IE,SINGLE 
  45.                 SPACE) AND 9.
  46.  
  47. B.  USE OF THE PROGRAM
  48.  
  49.         THE COMPLETE SYNTAX IS: 
  50.  
  51.             CLEANTXT <SOURCE_FILE >TARGET_FILE /H /U /L /F /E /+N
  52.  
  53.    COMMENTS:       
  54.         -THE SOURCE_FILE MUST BE ALWAYS BE INCLUDED.
  55.         -IF THE TARGET_FILE IS OMITTED, THE OUTPUT IS SENT TO THE 
  56.          SCREEN. 
  57.         
  58.         -THE SWITCHES SHOWN ARE OPTIONAL AND MEAN:
  59.  
  60.           /H   STRIP HIGH BITS
  61.           /U   MAKE ALL CHARACTERS UPPER CASE
  62.           /L   MAKE ALL CHARACTERS LOWER CASE
  63.           /F   DELETE FORM FEEDS
  64.           /E   DELETE EXTENDED CHARACTERS (ASCII 128 OR GREATER)
  65.           /+N  SET THE MAXIMUM BLANK LINES YOU WANT LEFT BETWEEN TEXT.  
  66.                  N REFERS TO A DIGIT BETWEEN 0 AND 9.
  67.  
  68.           ANY OR ALL SWITCHES CAN BE USED AT ONE TIME IN THE COMMAND, 
  69.           ALTHOUGH USING CERTAIN ONES IN PAIRS DOESN'T MAKE SENSE(IE, /U 
  70.           /L TELLS CLEANTXT TO BOTH MAKE ALL CHARACTERS UPPER AND ALSO 
  71.           LOWER CASE AT THE SAME TIME!) 
  72.  
  73. C: EXAMPLES
  74.  
  75.      CLEANTXT 
  76.                         CLEANTXT TYPED WITH NO PARAMETERS WILL GIVE A HELP 
  77.                         MESSAGE. 
  78.  
  79.      CLEANTXT <FILE1.TXT           
  80.                         THIS WILL CLEAN FILE1.TXT AND SEND THE OUTPUT 
  81.                         TO THE SCREEN. NO OPTIONS USED. 
  82.                                 
  83.  
  84.      CLEANTXT <FILE1.TXT >FILE2.TXT
  85.                         THIS WILL SEND THE OUPUT TO FILE2.TXT. NO 
  86.                         OPTIONS USED. 
  87.                         
  88.      CLEANTXT <FILE1.TXT >FILE2.TXT /U /+1 /F
  89.                         THIS WILL CLEAN FILE1.TXT, SEND OUTPUT TO 
  90.                         FILE2.TXT. OPTIONS CALLED FOR WILL CONVERT ALL 
  91.                         LETTERS TO UPPER CASE, DELETE FORM FEEDS, AND 
  92.                         ALLOW NO MORE THAN ONE BLANK LINE BETWEEN TEXT.  
  93.                         THIS COMMAND COULD BE USED TAKE A FILE FORMATED 
  94.                         FOR PRINTING AND DELETE THE FORM FEEDS AND 
  95.                         EXTRA BLANK LINES NEAR EACH PAGE BREAK. 
  96.  
  97.      CLEANTXT <FILE.COM >FILE.TXT /E /+0
  98.                         WITH THIS COMMAND YOU CAN LOOK AT THE TEXT IN 
  99.                         ANY 'COM' OR 'EXE' EXECUTABLE FILE.  THE 
  100.                         OPTIONS CALLED FOR WILL DELETE  ASCII 
  101.                         CHARACTERS GREATER THAN 128 AND WILL ONLY ALLOW 
  102.                         SINGLE SPACE OUTPUT.  THIS IS A FASTER WAY OF 
  103.                         LOOKING AT TEXT IN ANY EXECUTABLE FILE THAN 
  104.                         USING DEBUG OR A HEX DUMP PROGRAM. 
  105.  
  106.  
  107.      DIR |CLEANTXT >DIR.TXT  /L
  108.                         HERE THE DOS PIPE COMMAND '|' SENDS THE OUTPUT 
  109.                         OF 'DIR' TO 'CLEANTXT' WHICH SENDS ITS OUTPUT INTO 
  110.                         THE FILE DIR.TXT AFTER MAKING IT LOWER CASE. 
  111.  
  112. D: HISTORY
  113.  
  114.         THE ORIGINAL NEED FOR THIS PROGRAM OCCURRED WHEN I WAS 
  115.         PREPARING DOCUMENATION FOR A PROGRAM.  I WAS USING A SCREEN 
  116.         CAPTURE PROGRAM TO DUMP THE IMAGE ON THE CRT  TO A 
  117.         FILE.  THE FILE CONTAINING THE SCREEN DUMP COULD NOT BE 
  118.         DIRECTLY EDITED BY MY WORD PROCESSOR, PC-WRITE, BECAUSE THE 
  119.         CARRIAGE RETURNS AND LINE FEEDS  WHERE OUT OF ORDER FROM WHAT 
  120.         PC-WRITE EXPECTED (PC-WRITE EXPECTS THAT A CARRIAGE RETURN 
  121.         PRECEEDS EVERY LINE FEED). FURTHER, EVERY LINE IN THE SCREEN 
  122.         DUMP FILE  WAS 80 CHARACTERS WIDE. THIS MEANT THAT A BLANK LINE 
  123.         WAS REPRESENTED BY 80 SPACES (BIG WASTE OF FILE SPACE!). 
  124.  
  125.         THUS, I WROTE THE ORIGINAL CLEANTXT PROGRAM TO DELETE THESE 
  126.         TRAILING SPACES AND FIX UP THE CARRIAGE RETURN-LINE FEED 
  127.         SEQUENCE.  IN AN ACTUAL TEST, THE CLEANTXT PROGRAM REDUCED THE 
  128.         SIZE OF A TYPICAL SCREEN DUMP FILE FROM 6656 BYTES TO 1478 
  129.         BYTES (78% REDUCTION). 
  130.  
  131.         THE OTHER OPTIONS WERE ADDED LATER. 
  132.  
  133.  
  134.